<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="connectors_v2.html">Connectors API</a> . <a href="connectors_v2.projects.html">projects</a> . <a href="connectors_v2.projects.locations.html">locations</a> . <a href="connectors_v2.projects.locations.connections.html">connections</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="connectors_v2.projects.locations.connections.actions.html">actions()</a></code>
</p>
<p class="firstline">Returns the actions Resource.</p>

<p class="toc_element">
  <code><a href="connectors_v2.projects.locations.connections.entityTypes.html">entityTypes()</a></code>
</p>
<p class="firstline">Returns the entityTypes Resource.</p>

<p class="toc_element">
  <code><a href="connectors_v2.projects.locations.connections.resources.html">resources()</a></code>
</p>
<p class="firstline">Returns the resources Resource.</p>

<p class="toc_element">
  <code><a href="connectors_v2.projects.locations.connections.tools.html">tools()</a></code>
</p>
<p class="firstline">Returns the tools Resource.</p>

<p class="toc_element">
  <code><a href="#checkReadiness">checkReadiness(name, x__xgafv=None)</a></code></p>
<p class="firstline">Reports readiness status of the connector. Similar logic to GetStatus but modified for kubernetes health check to understand.</p>
<p class="toc_element">
  <code><a href="#checkStatus">checkStatus(name, x__xgafv=None)</a></code></p>
<p class="firstline">Reports the status of the connection. Note that when the connection is in a state that is not ACTIVE, the implementation of this RPC method must return a Status with the corresponding State instead of returning a gRPC status code that is not "OK", which indicates that ConnectionStatus itself, not the connection, failed.</p>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#exchangeAuthCode">exchangeAuthCode(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">ExchangeAuthCode exchanges the OAuth authorization code (and other necessary data) for an access token (and associated credentials).</p>
<p class="toc_element">
  <code><a href="#executeSqlQuery">executeSqlQuery(connection, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Executes a SQL statement specified in the body of the request. An example of this SQL statement in the case of Salesforce connector would be 'select * from Account a, Order o where a.Id = o.AccountId'.</p>
<p class="toc_element">
  <code><a href="#refreshAccessToken">refreshAccessToken(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">RefreshAccessToken exchanges the OAuth refresh token (and other necessary data) for a new access token (and new associated credentials).</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="checkReadiness">checkReadiness(name, x__xgafv=None)</code>
  <pre>Reports readiness status of the connector. Similar logic to GetStatus but modified for kubernetes health check to understand.

Args:
  name: string, A parameter (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response containing status of the connector for readiness prober.
  &quot;status&quot;: &quot;A String&quot;,
}</pre>
</div>

<div class="method">
    <code class="details" id="checkStatus">checkStatus(name, x__xgafv=None)</code>
  <pre>Reports the status of the connection. Note that when the connection is in a state that is not ACTIVE, the implementation of this RPC method must return a Status with the corresponding State instead of returning a gRPC status code that is not &quot;OK&quot;, which indicates that ConnectionStatus itself, not the connection, failed.

Args:
  name: string, A parameter (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The status of the connector.
  &quot;description&quot;: &quot;A String&quot;, # When the connector is not in ACTIVE state, the description must be populated to specify the reason why it&#x27;s not in ACTIVE state.
  &quot;metadata&quot;: { # Metadata like service latency, etc.
    &quot;a_key&quot;: {
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
  },
  &quot;state&quot;: &quot;A String&quot;, # State of the connector.
}</pre>
</div>

<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="exchangeAuthCode">exchangeAuthCode(name, body=None, x__xgafv=None)</code>
  <pre>ExchangeAuthCode exchanges the OAuth authorization code (and other necessary data) for an access token (and associated credentials).

Args:
  name: string, A parameter (required)
  body: object, The request body.
    The object takes the form of:

{ # ExchangeAuthCodeRequest currently includes the auth code data.
  &quot;authCodeData&quot;: { # AuthCodeData contains the data the runtime plane will give the connector backend in exchange for access and refresh tokens. # Optional. AuthCodeData contains the data the runtime requires to exchange for access and refresh tokens. If the data is not provided, the runtime will read the data from the secret manager.
    &quot;authCode&quot;: &quot;A String&quot;, # OAuth authorization code.
    &quot;pkceVerifier&quot;: &quot;A String&quot;, # OAuth PKCE verifier, needed if PKCE is enabled for this particular connection.
    &quot;redirectUri&quot;: &quot;A String&quot;, # OAuth redirect URI passed in during the auth code flow, required by some OAuth backends.
    &quot;scopes&quot;: [ # Scopes the connection will request when the user performs the auth code flow.
      &quot;A String&quot;,
    ],
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # ExchangeAuthCodeResponse includes the returned access token and its associated credentials.
  &quot;accessCredentials&quot;: { # AccessCredentials includes the OAuth access token, and the other fields returned along with it.
    &quot;accessToken&quot;: &quot;A String&quot;, # OAuth access token.
    &quot;expiresIn&quot;: &quot;A String&quot;, # Duration till the access token expires.
    &quot;refreshToken&quot;: &quot;A String&quot;, # OAuth refresh token.
  },
  &quot;metadata&quot;: { # Metadata like service latency, etc.
    &quot;a_key&quot;: {
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="executeSqlQuery">executeSqlQuery(connection, body=None, x__xgafv=None)</code>
  <pre>Executes a SQL statement specified in the body of the request. An example of this SQL statement in the case of Salesforce connector would be &#x27;select * from Account a, Order o where a.Id = o.AccountId&#x27;.

Args:
  connection: string, Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection} (required)
  body: object, The request body.
    The object takes the form of:

{ # An execute sql query request containing the query and the connection to execute it on.
  &quot;query&quot;: { # A wrapper around the SQL query statement. This is needed so that the JSON representation of ExecuteSqlQueryRequest has the following format: `{&quot;query&quot;:&quot;select *&quot;}`. # Required. SQL statement passed by clients like Integration Platform, the query is passed as-is to the driver used for interfacing with external systems.
    &quot;maxRows&quot;: &quot;A String&quot;, # Sets the limit for the maximum number of rows returned after the query execution.
    &quot;query&quot;: &quot;A String&quot;, # Required. Sql query to execute.
    &quot;queryParameters&quot;: [ # In the struct, the value corresponds to the value of query parameter and date type corresponds to the date type of the query parameter.
      { # Query parameter definition
        &quot;dataType&quot;: &quot;A String&quot;,
        &quot;value&quot;: &quot;&quot;,
      },
    ],
    &quot;timeout&quot;: &quot;A String&quot;, # Sets the number of seconds the driver will wait for a query to execute.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A response returned by the connection after executing the sql query.
  &quot;results&quot;: [ # In the case of successful execution of the query the response contains results returned by the external system. For example, the result rows of the query are contained in the &#x27;results&#x27; Struct list - &quot;results&quot;: [ { &quot;field1&quot;: &quot;val1&quot;, &quot;field2&quot;: &quot;val2&quot;,.. },.. ] Each Struct row can contain fields any type of like nested Structs or lists.
    {
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="refreshAccessToken">refreshAccessToken(name, body=None, x__xgafv=None)</code>
  <pre>RefreshAccessToken exchanges the OAuth refresh token (and other necessary data) for a new access token (and new associated credentials).

Args:
  name: string, A parameter (required)
  body: object, The request body.
    The object takes the form of:

{ # RefreshAccessTokenRequest includes the refresh token.
  &quot;refreshToken&quot;: &quot;A String&quot;, # Optional. Refresh Token String. If the Refresh Token is not provided, the runtime will read the data from the secret manager.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # RefreshAccessTokenResponse includes the returned access token and its associated credentials.
  &quot;accessCredentials&quot;: { # AccessCredentials includes the OAuth access token, and the other fields returned along with it.
    &quot;accessToken&quot;: &quot;A String&quot;, # OAuth access token.
    &quot;expiresIn&quot;: &quot;A String&quot;, # Duration till the access token expires.
    &quot;refreshToken&quot;: &quot;A String&quot;, # OAuth refresh token.
  },
  &quot;metadata&quot;: { # Metadata like service latency, etc.
    &quot;a_key&quot;: {
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
  },
}</pre>
</div>

</body></html>